Skip to content

Add OAuthConsent and useOAuthConsent docs#3315

Open
wobsoriano wants to merge 26 commits into
mainfrom
rob/oauth-consent-docs
Open

Add OAuthConsent and useOAuthConsent docs#3315
wobsoriano wants to merge 26 commits into
mainfrom
rob/oauth-consent-docs

Conversation

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 23, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clerk-docs Ready Ready Preview May 11, 2026 9:12pm

Request Review

@wobsoriano wobsoriano marked this pull request as ready for review May 1, 2026 17:11
@wobsoriano wobsoriano requested a review from a team as a code owner May 1, 2026 17:11
@SarahSoutoul
Copy link
Copy Markdown
Contributor

SarahSoutoul commented May 4, 2026

@wobsoriano have submitted a docs review with some minor changes:

  • Replaced instances of "signed-in users" with "authenticated users".
  • Rephrased some of the <OAuthConsent /> component intro to make it a bit more smooth.
  • Changed some of the props descriptions for the <OAuthConsent /> component to align with rest of the docs.

Let me know what you think, and left some comments too!

Comment thread docs/reference/hooks/use-oauth-consent.mdx Outdated
Comment thread docs/reference/components/authentication/oauth-consent.mdx
Comment thread docs/reference/hooks/use-oauth-consent.mdx Outdated
@SarahSoutoul
Copy link
Copy Markdown
Contributor

this is perfect! I tested with typedoc generation, and everything is working.

my only qualm is putting OAuthApplication in the objects dropdown. we've talked about this distinction before: what are we considering the main Clerk objects? and then everything else gets thrown into /types in my opinion, I don't consider this a main Clerk object. well yes, it exists on the Clerk object, I don't see this as a frequently used object necessary for building a typical app, while all the other "main" Clerk objects are pretty much non-negotiable when building an app. so imo, I'd move this one to /types

Yeah I was in the same boat yesterday debating whether it should be in /objects or /types. Let's move it to types then - that explanation makes sense and justifies it. @wobsoriano I'll do it!

@SarahSoutoul
Copy link
Copy Markdown
Contributor

Make OAuthApplication a type

@wobsoriano @alexisintech just pushed a commit to make OAuthApplication a type rather than an object. Let me know thoughts!

Comment thread docs/reference/objects/clerk.mdx Outdated

---

- `oauthApplication`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so it does exist on the clerk object, so it's fine to keep it here. i just meant that it doesn't need be in /objects and under objects in the manifest!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also, towards the bottom there's a section called "Components"
it will need a section for mountOAuthConsent and unmountOAuthconsent like the other components listed there!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alexisintech
Copy link
Copy Markdown
Member

could you please add all the relevant links added to the PR description here? any JS repo PR's that were related to releasing this future, and the PR's that were related to typedoc changes
we need as much context provided in the PR description as possible 🫶 (more details on this process here)

@SarahSoutoul
Copy link
Copy Markdown
Contributor

could you please add all the relevant links added to the PR description here? any JS repo PR's that were related to releasing this future, and the PR's that were related to typedoc changes we need as much context provided in the PR description as possible 🫶 (more details on this process here)

@wobsoriano have added the Typedoc PRs related to this but I'll let you add the JS repo PR'S related to releasing this feature.

@SarahSoutoul
Copy link
Copy Markdown
Contributor

Okay @wobsoriano @alexisintech this is ready for a final review!

@SarahSoutoul SarahSoutoul requested a review from alexisintech May 8, 2026 21:15
@alexisintech
Copy link
Copy Markdown
Member

right now, the callout about setting the referrer policy is in the intro section for the component, but the returns section for the hook - was there any specific reasoning behind having it in the returns section for the hook?
imo, it should go in either the intro paragraph/section or the example section! but let's be consistent between the component and hook pages :)

Copy link
Copy Markdown
Member

@alexisintech alexisintech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small comment about the placement of the callout for setting the referrer policy but its non-blocking, so i'm going to approve!
i've tested all the links, and all links embedded in those pages, everything looks to be working! thanks for the hard work on this guys 🫶

@SarahSoutoul
Copy link
Copy Markdown
Contributor

SarahSoutoul commented May 11, 2026

right now, the callout about setting the referrer policy is in the intro section for the component, but the returns section for the hook - was there any specific reasoning behind having it in the returns section for the hook? imo, it should go in either the intro paragraph/section or the example section! but let's be consistent between the component and hook pages :)

Have updated the wording of the callout here, but yeah got the same question @wobsoriano - I'd be keen to make the placement consistent before merging this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants